home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / gnu / a2_0bEmacs_bin.lha / Emacs-19.25 / info / emacs-4 (.txt) < prev    next >
GNU Info File  |  1992-02-21  |  48KB  |  846 lines

  1. This is Info file ../info/emacs, produced by Makeinfo-1.43 from the
  2. input file emacs.tex.
  3.    This file documents the GNU Emacs editor.
  4.    Copyright (C) 1985, 1986, 1988 Richard M. Stallman.
  5.    Permission is granted to make and distribute verbatim copies of
  6. this manual provided the copyright notice and this permission notice
  7. are preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided also
  10. that the sections entitled "The GNU Manifesto", "Distribution" and "GNU
  11. General Public License" are included exactly as in the original, and
  12. provided that the entire resulting derived work is distributed under
  13. the terms of a permission notice identical to this one.
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that the sections entitled "The GNU Manifesto",
  17. "Distribution" and "GNU General Public License" may be included in a
  18. translation approved by the author instead of in the original English.
  19. File: emacs,  Node: Display Vars,  Prev: Selective Display,  Up: Display
  20. Variables Controlling Display
  21. =============================
  22.    This section contains information for customization only.  Beginning
  23. users should skip it.
  24.    The variable `mode-line-inverse-video' controls whether the mode
  25. line is displayed in inverse video (assuming the terminal supports it);
  26. `nil' means don't do so.  *Note Mode Line::.
  27.    If the variable `inverse-video' is non-`nil', Emacs attempts to
  28. invert all the lines of the display from what they normally are.
  29.    If the variable `visible-bell' is non-`nil', Emacs attempts to make
  30. the whole screen blink when it would normally make an audible bell
  31. sound.  This variable has no effect if your terminal does not have a
  32. way to make the screen blink.
  33.    When you reenter Emacs after suspending, Emacs normally clears the
  34. screen and redraws the entire display.  On some terminals with more
  35. than one page of memory, it is possible to arrange the termcap entry
  36. so that the `ti' and `te' strings (output to the terminal when Emacs is
  37. entered and exited, respectively) switch between pages of memory so as
  38. to use one page for Emacs and another page for other output.  Then you
  39. might want to set the variable `no-redraw-on-reenter' non-`nil' so that
  40. Emacs will assume, when resumed, that the screen page it is using still
  41. contains what Emacs last wrote there.
  42.    The variable `echo-keystrokes' controls the echoing of
  43. multi-character keys; its value is the number of seconds of pause
  44. required to cause echoing to start, or zero meaning don't echo at all.
  45.  *Note Echo Area::.
  46.    If the variable `ctl-arrow' is `nil', control characters in the
  47. buffer are displayed with octal escape sequences, all except newline
  48. and tab.  Altering the value of `ctl-arrow' makes it local to the
  49. current buffer; until that time, the default value is in effect.  The
  50. default is initially `t'.  *Note Locals::.
  51.    Normally, a tab character in the buffer is displayed as whitespace
  52. which extends to the next display tab stop position, and display tab
  53. stops come at intervals equal to eight spaces.  The number of spaces
  54. per tab is controlled by the variable `tab-width', which is made local
  55. by changing it, just like `ctl-arrow'.  Note that how the tab character
  56. in the buffer is displayed has nothing to do with the definition of
  57. TAB as a command.
  58.    If you set the variable `selective-display-ellipses' to `nil', the
  59. three dots do not appear at the end of a line that precedes invisible
  60. lines.  Then there is no visible indication of the invisible lines. 
  61. This variable too becomes local automatically when set.
  62. File: emacs,  Node: Search,  Next: Fixit,  Prev: Display,  Up: Top
  63. Searching and Replacement
  64. *************************
  65.    Like other editors, Emacs has commands for searching for
  66. occurrences of a string.  The principal search command is unusual in
  67. that it is "incremental"; it begins to search before you have finished
  68. typing the search string.  There are also nonincremental search
  69. commands more like those of other editors.
  70.    Besides the usual `replace-string' command that finds all
  71. occurrences of one string and replaces them with another, Emacs has a
  72. fancy replacement command called `query-replace' which asks
  73. interactively which occurrences to replace.
  74. * Menu:
  75. * Incremental Search::     Search happens as you type the string.
  76. * Nonincremental Search::  Specify entire string and then search.
  77. * Word Search::            Search for sequence of words.
  78. * Regexp Search::          Search for match for a regexp.
  79. * Regexps::                Syntax of regular expressions.
  80. * Search Case::            To ignore case while searching, or not.
  81. * Replace::                Search, and replace some or all matches.
  82. * Other Repeating Search:: Operating on all matches for some regexp.
  83. File: emacs,  Node: Incremental Search,  Next: Nonincremental Search,  Prev: Search,  Up: Search
  84. Incremental Search
  85. ==================
  86.    An incremental search begins searching as soon as you type the first
  87. character of the search string.  As you type in the search string,
  88. Emacs shows you where the string (as you have typed it so far) would
  89. be found.  When you have typed enough characters to identify the place
  90. you want, you can stop.  Depending on what you will do next, you may
  91. or may not need to terminate the search explicitly with an ESC first.
  92. `C-s'
  93.      Incremental search forward (`isearch-forward').
  94. `C-r'
  95.      Incremental search backward (`isearch-backward').
  96.    `C-s' starts an incremental search.  `C-s' reads characters from
  97. the keyboard and positions the cursor at the first occurrence of the
  98. characters that you have typed.  If you type `C-s' and then `F', the
  99. cursor moves right after the first `F'.  Type an `O', and see the
  100. cursor move to after the first `FO'.  After another `O', the cursor is
  101. after the first `FOO' after the place where you started the search. 
  102. Meanwhile, the search string `FOO' has been echoed in the echo area.
  103.    The echo area display ends with three dots when actual searching is
  104. going on.  When search is waiting for more input, the three dots are
  105. removed.  (On slow terminals, the three dots are not displayed.)
  106.    If you make a mistake in typing the search string, you can erase
  107. characters with DEL.  Each DEL cancels the last character of search
  108. string.  This does not happen until Emacs is ready to read another
  109. input character; first it must either find, or fail to find, the
  110. character you want to erase.  If you do not want to wait for this to
  111. happen, use `C-g' as described below.
  112.    When you are satisfied with the place you have reached, you can type
  113. ESC, which stops searching, leaving the cursor where the search
  114. brought it.  Also, any command not specially meaningful in searches
  115. stops the searching and is then executed.  Thus, typing `C-a' would
  116. exit the search and then move to the beginning of the line.  ESC is
  117. necessary only if the next command you want to type is a printing
  118. character, DEL, ESC, or another control character that is special
  119. within searches (`C-q', `C-w', `C-r', `C-s' or `C-y').
  120.    Sometimes you search for `FOO' and find it, but not the one you
  121. expected to find.  There was a second `FOO' that you forgot about,
  122. before the one you were looking for.  In this event, type another `C-s'
  123. to move to the next occurrence of the search string.  This can be done
  124. any number of times.  If you overshoot, you can cancel some `C-s'
  125. characters with DEL.
  126.    After you exit a search, you can search for the same string again by
  127. typing just `C-s C-s': the first `C-s' is the key that invokes
  128. incremental search, and the second `C-s' means "search again".
  129.    If your string is not found at all, the echo area says `Failing
  130. I-Search'.  The cursor is after the place where Emacs found as much of
  131. your string as it could.  Thus, if you search for `FOOT', and there is
  132. no `FOOT', you might see the cursor after the `FOO' in `FOOL'.  At
  133. this point there are several things you can do.  If your string was
  134. mistyped, you can rub some of it out and correct it.  If you like the
  135. place you have found, you can type ESC or some other Emacs command to
  136. "accept what the search offered".  Or you can type `C-g', which
  137. removes from the search string the characters that could not be found
  138. (the `T' in `FOOT'), leaving those that were found (the `FOO' in
  139. `FOOT').  A second `C-g' at that point cancels the search entirely,
  140. returning point to where it was when the search started.
  141.    If a search is failing and you ask to repeat it by typing another
  142. `C-s', it starts again from the beginning of the buffer.  Repeating a
  143. failing reverse search with `C-r' starts again from the end.  This is
  144. called "wrapping around".  `Wrapped' appears in the search prompt once
  145. this has happened.
  146.    The `C-g' "quit" character does special things during searches;
  147. just what it does depends on the status of the search.  If the search
  148. has found what you specified and is waiting for input, `C-g' cancels
  149. the entire search.  The cursor moves back to where you started the
  150. search.  If `C-g' is typed when there are characters in the search
  151. string that have not been found--because Emacs is still searching for
  152. them, or because it has failed to find them--then the search string
  153. characters which have not been found are discarded from the search
  154. string.  With them gone, the search is now successful and waiting for
  155. more input, so a second `C-g' will cancel the entire search.
  156.    To search for a control character such as `C-s' or DEL or ESC, you
  157. must quote it by typing `C-q' first.  This function of `C-q' is
  158. analogous to its meaning as an Emacs command: it causes the following
  159. character to be treated the way a graphic character would normally be
  160. treated in the same context.
  161.    You can change to searching backwards with `C-r'.  If a search fails
  162. because the place you started was too late in the file, you should do
  163. this.  Repeated `C-r' keeps looking for more occurrences backwards.  A
  164. `C-s' starts going forwards again.  `C-r' in a search can be cancelled
  165. with DEL.
  166.    If you know initially that you want to search backwards, you can
  167. use `C-r' instead of `C-s' to start the search, because `C-r' is also
  168. a key running a command (`isearch-backward') to search backward.
  169.    The characters `C-y' and `C-w' can be used in incremental search to
  170. grab text from the buffer into the search string.  This makes it
  171. convenient to search for another occurrence of text at point.  `C-w'
  172. copies the word after point as part of the search string, advancing
  173. point over that word.  Another `C-s' to repeat the search will then
  174. search for a string including that word.  `C-y' is similar to `C-w'
  175. but copies all the rest of the current line into the search string.
  176.    All the characters special in incremental search can be changed by
  177. setting the following variables:
  178. `search-delete-char'
  179.      Character to delete from incremental search string (normally DEL).
  180. `search-exit-char'
  181.      Character to exit incremental search (normally ESC).
  182. `search-quote-char'
  183.      Character to quote special characters for incremental search
  184.      (normally `C-q').
  185. `search-repeat-char'
  186.      Character to repeat incremental search forwards (normally `C-s').
  187. `search-reverse-char'
  188.      Character to repeat incremental search backwards (normally `C-r').
  189. `search-yank-line-char'
  190.      Character to pull rest of line from buffer into search string
  191.      (normally `C-y').
  192. `search-yank-word-char'
  193.      Character to pull next word from buffer into search string
  194.      (normally `C-w').
  195. Slow Terminal Incremental Search
  196. --------------------------------
  197.    Incremental search on a slow terminal uses a modified style of
  198. display that is designed to take less time.  Instead of redisplaying
  199. the buffer at each place the search gets to, it creates a new
  200. single-line window and uses that to display the line that the search
  201. has found.  The single-line window comes into play as soon as point
  202. gets outside of the text that is already on the screen.
  203.    When the search is terminated, the single-line window is removed. 
  204. Only at this time is the window in which the search was done
  205. redisplayed to show its new value of point.
  206.    The three dots at the end of the search string, normally used to
  207. indicate that searching is going on, are not displayed in slow style
  208. display.
  209.    The slow terminal style of display is used when the terminal baud
  210. rate is less than or equal to the value of the variable
  211. `search-slow-speed', initially 1200.
  212.    The number of lines to use in slow terminal search display is
  213. controlled by the variable `search-slow-window-lines'.  1 is its
  214. normal value.
  215. File: emacs,  Node: Nonincremental Search,  Next: Word Search,  Prev: Incremental Search,  Up: Search
  216. Nonincremental Search
  217. =====================
  218.    Emacs also has conventional nonincremental search commands, which
  219. require you to type the entire search string before searching begins.
  220. `C-s ESC STRING RET'
  221.      Search for STRING.
  222. `C-r ESC STRING RET'
  223.      Search backward for STRING.
  224.    To do a nonincremental search, first type `C-s ESC'.  This enters
  225. the minibuffer to read the search string; terminate the string with
  226. RET, and then the search is done.  If the string is not found the
  227. search command gets an error.
  228.    The way `C-s ESC' works is that the `C-s' invokes incremental
  229. search, which is specially programmed to invoke nonincremental search
  230. if the argument you give it is empty.  (Such an empty argument would
  231. otherwise be useless.)  `C-r ESC' also works this way.
  232.    Forward and backward nonincremental searches are implemented by the
  233. commands `search-forward' and `search-backward'.  These commands may
  234. be bound to keys in the usual manner.  The reason that incremental
  235. search is programmed to invoke them as well is that `C-s ESC' is the
  236. traditional sequence of characters used in Emacs to invoke
  237. nonincremental search.
  238.    However, nonincremental searches performed using `C-s ESC' do not
  239. call `search-forward' right away.  The first thing done is to see if
  240. the next character is `C-w', which requests a word search.  *Note Word
  241. Search::.
  242. File: emacs,  Node: Word Search,  Next: Regexp Search,  Prev: Nonincremental Search,  Up: Search
  243. Word Search
  244. ===========
  245.    Word search searches for a sequence of words without regard to how
  246. the words are separated.  More precisely, you type a string of many
  247. words, using single spaces to separate them, and the string can be
  248. found even if there are multiple spaces, newlines or other punctuation
  249. between the words.
  250.    Word search is useful in editing documents formatted by text
  251. formatters.  If you edit while looking at the printed, formatted
  252. version, you can't tell where the line breaks are in the source file. 
  253. With word search, you can search without having to know them.
  254. `C-s ESC C-w WORDS RET'
  255.      Search for WORDS, ignoring differences in punctuation.
  256. `C-r ESC C-w WORDS RET'
  257.      Search backward for WORDS, ignoring differences in punctuation.
  258.    Word search is a special case of nonincremental search and is
  259. invoked with `C-s ESC C-w'.  This is followed by the search string,
  260. which must always be terminated with RET.  Being nonincremental, this
  261. search does not start until the argument is terminated.  It works by
  262. constructing a regular expression and searching for that.  *Note
  263. Regexp Search::.
  264.    A backward word search can be done by `C-r ESC C-w'.
  265.    Forward and backward word searches are implemented by the commands
  266. `word-search-forward' and `word-search-backward'.  These commands may
  267. be bound to keys in the usual manner.  The reason that incremental
  268. search is programmed to invoke them as well is that `C-s ESC C-w' is
  269. the traditional Emacs sequence of keys for word search.
  270. File: emacs,  Node: Regexp Search,  Next: Regexps,  Prev: Word Search,  Up: Search
  271. Regular Expression Search
  272. =========================
  273.    A "regular expression" ("regexp", for short) is a pattern that
  274. denotes a set of strings, possibly an infinite set.  Searching for
  275. matches for a regexp is a very powerful operation that editors on Unix
  276. systems have traditionally offered.  In GNU Emacs, you can search for
  277. the next match for a regexp either incrementally or not.
  278.    Incremental search for a regexp is done by typing `C-M-s'
  279. (`isearch-forward-regexp').  This command reads a search string
  280. incrementally just like `C-s', but it treats the search string as a
  281. regexp rather than looking for an exact match against the text in the
  282. buffer.  Each time you add text to the search string, you make the
  283. regexp longer, and the new regexp is searched for.  A reverse regexp
  284. search command `isearch-backward-regexp' also exists but no key runs
  285.    All of the control characters that do special things within an
  286. ordinary incremental search have the same function in incremental
  287. regexp search.  Typing `C-s' or `C-r' immediately after starting the
  288. search retrieves the last incremental search regexp used; that is to
  289. say, incremental regexp and non-regexp searches have independent
  290. defaults.
  291.    Note that adding characters to the regexp in an incremental regexp
  292. search does not make the cursor move back and start again.  Perhaps it
  293. ought to; I am not sure.  As it stands, if you have searched for `foo'
  294. and you add `\|bar', the search will not check for a `bar' in the
  295. buffer before the `foo'.
  296.    Nonincremental search for a regexp is done by the functions
  297. `re-search-forward' and `re-search-backward'.  You can invoke these
  298. with `M-x', or bind them to keys.  Also, you can call
  299. `re-search-forward' by way of incremental regexp search with `C-M-s
  300. ESC'.
  301. File: emacs,  Node: Regexps,  Next: Search Case,  Prev: Regexp Search,  Up: Search
  302. Syntax of Regular Expressions
  303. =============================
  304.    Regular expressions have a syntax in which a few characters are
  305. special constructs and the rest are "ordinary".  An ordinary character
  306. is a simple regular expression which matches that character and
  307. nothing else.  The special characters are `$', `^', `.', `*', `+',
  308. `?', `[', `]' and `\'; no new special characters will be defined.  Any
  309. other character appearing in a regular expression is ordinary, unless
  310. a `\' precedes it.
  311.    For example, `f' is not a special character, so it is ordinary, and
  312. therefore `f' is a regular expression that matches the string `f' and
  313. no other string.  (It does not match the string `ff'.)  Likewise, `o'
  314. is a regular expression that matches only `o'.
  315.    Any two regular expressions A and B can be concatenated.  The
  316. result is a regular expression which matches a string if A matches
  317. some amount of the beginning of that string and B matches the rest of
  318. the string.
  319.    As a simple example, we can concatenate the regular expressions `f'
  320. and `o' to get the regular expression `fo', which matches only the
  321. string `fo'.  Still trivial.  To do something nontrivial, you need to
  322. use one of the special characters.  Here is a list of them.
  323. `. (Period)'
  324.      is a special character that matches any single character except a
  325.      newline.  Using concatenation, we can make regular expressions
  326.      like `a.b' which matches any three-character string which begins
  327.      with `a' and ends with `b'.
  328.      is not a construct by itself; it is a suffix, which means the
  329.      preceding regular expression is to be repeated as many times as
  330.      possible.  In `fo*', the `*' applies to the `o', so `fo*' matches
  331.      one `f' followed by any number of `o's.  The case of zero `o's is
  332.      allowed: `fo*' does match `f'.
  333.      `*' always applies to the smallest possible preceding expression.
  334.       Thus, `fo*' has a repeating `o', not a repeating `fo'.
  335.      The matcher processes a `*' construct by matching, immediately,
  336.      as many repetitions as can be found.  Then it continues with the
  337.      rest of the pattern.  If that fails, backtracking occurs,
  338.      discarding some of the matches of the `*'-modified construct in
  339.      case that makes it possible to match the rest of the pattern. 
  340.      For example, matching `ca*ar' against the string `caaar', the
  341.      `a*' first tries to match all three `a's; but the rest of the
  342.      pattern is `ar' and there is only `r' left to match, so this try
  343.      fails.  The next alternative is for `a*' to match only two `a's. 
  344.      With this choice, the rest of the regexp matches successfully.
  345.      Is a suffix character similar to `*' except that it requires that
  346.      the preceding expression be matched at least once.  So, for
  347.      example, `ca+r' will match the strings `car' and `caaaar' but not
  348.      the string `cr', whereas `ca*r' would match all three strings.
  349.      Is a suffix character similar to `*' except that it can match the
  350.      preceding expression either once or not at all.  For example,
  351.      `ca?r' will match `car' or `cr'; nothing else.
  352. `[ ... ]'
  353.      `[' begins a "character set", which is terminated by a `]'.  In
  354.      the simplest case, the characters between the two form the set. 
  355.      Thus, `[ad]' matches either one `a' or one `d', and `[ad]*'
  356.      matches any string composed of just `a's and `d's (including the
  357.      empty string), from which it follows that `c[ad]*r' matches `cr',
  358.      `car', `cdr', `caddaar', etc.
  359.      Character ranges can also be included in a character set, by
  360.      writing two characters with a `-' between them.  Thus, `[a-z]'
  361.      matches any lower-case letter.  Ranges may be intermixed freely
  362.      with individual characters, as in `[a-z$%.]', which matches any
  363.      lower case letter or `$', `%' or period.
  364.      Note that the usual special characters are not special any more
  365.      inside a character set.  A completely different set of special
  366.      characters exists inside character sets: `]', `-' and `^'.
  367.      To include a `]' in a character set, you must make it the first
  368.      character.  For example, `[]a]' matches `]' or `a'.  To include a
  369.      `-', write `---', which is a range containing only `-'.  To
  370.      include `^', make it other than the first character in the set.
  371. `[^ ... ]'
  372.      `[^' begins a "complement character set", which matches any
  373.      character except the ones specified.  Thus, `[^a-z0-9A-Z]'
  374.      matches all characters except letters and digits.
  375.      `^' is not special in a character set unless it is the first
  376.      character.  The character following the `^' is treated as if it
  377.      were first (`-' and `]' are not special there).
  378.      Note that a complement character set can match a newline, unless
  379.      newline is mentioned as one of the characters not to match.
  380.      is a special character that matches the empty string, but only if
  381.      at the beginning of a line in the text being matched.  Otherwise
  382.      it fails to match anything.  Thus, `^foo' matches a `foo' which
  383.      occurs at the beginning of a line.
  384.      is similar to `^' but matches only at the end of a line.  Thus,
  385.      `xx*$' matches a string of one `x' or more at the end of a line.
  386.      has two functions: it quotes the special characters (including
  387.      `\'), and it introduces additional special constructs.
  388.      Because `\' quotes special characters, `\$' is a regular
  389.      expression which matches only `$', and `\[' is a regular
  390.      expression which matches only `[', and so on.
  391.    Note: for historical compatibility, special characters are treated
  392. as ordinary ones if they are in contexts where their special meanings
  393. make no sense.  For example, `*foo' treats `*' as ordinary since there
  394. is no preceding expression on which the `*' can act.  It is poor
  395. practice to depend on this behavior; better to quote the special
  396. character anyway, regardless of where is appears.
  397.    For the most part, `\' followed by any character matches only that
  398. character.  However, there are several exceptions: characters which,
  399. when preceded by `\', are special constructs.  Such characters are
  400. always ordinary when encountered on their own.  Here is a table of `\'
  401. constructs.
  402.      specifies an alternative.  Two regular expressions A and B with
  403.      `\|' in between form an expression that matches anything that
  404.      either A or B will match.
  405.      Thus, `foo\|bar' matches either `foo' or `bar' but no other
  406.      string.
  407.      `\|' applies to the largest possible surrounding expressions. 
  408.      Only a surrounding `\( ... \)' grouping can limit the grouping
  409.      power of `\|'.
  410.      Full backtracking capability exists to handle multiple uses of
  411.      `\|'.
  412. `\( ... \)'
  413.      is a grouping construct that serves three purposes:
  414.        1. To enclose a set of `\|' alternatives for other operations. 
  415.           Thus, `\(foo\|bar\)x' matches either `foox' or `barx'.
  416.        2. To enclose a complicated expression for the postfix `*' to
  417.           operate on.  Thus, `ba\(na\)*' matches `bananana', etc.,
  418.           with any (zero or more) number of `na' strings.
  419.        3. To mark a matched substring for future reference.
  420.      This last application is not a consequence of the idea of a
  421.      parenthetical grouping; it is a separate feature which happens to
  422.      be assigned as a second meaning to the same `\( ... \)' construct
  423.      because there is no conflict in practice between the two meanings. 
  424.      Here is an explanation of this feature:
  425. `\DIGIT'
  426.      after the end of a `\( ... \)' construct, the matcher remembers
  427.      the beginning and end of the text matched by that construct. 
  428.      Then, later on in the regular expression, you can use `\'
  429.      followed by DIGIT to mean "match the same text matched the
  430.      DIGIT'th time by the `\( ... \)' construct."
  431.      The strings matching the first nine `\( ... \)' constructs
  432.      appearing in a regular expression are assigned numbers 1 through
  433.      9 in order that the open-parentheses appear in the regular
  434.      expression.  `\1' through `\9' may be used to refer to the text
  435.      matched by the corresponding `\( ... \)' construct.
  436.      For example, `\(.*\)\1' matches any newline-free string that is
  437.      composed of two identical halves.  The `\(.*\)' matches the first
  438.      half, which may be anything, but the `\1' that follows must match
  439.      the same exact text.
  440.      matches the empty string, provided it is at the beginning of the
  441.      buffer.
  442.      matches the empty string, provided it is at the end of the buffer.
  443.      matches the empty string, provided it is at the beginning or end
  444.      of a word.  Thus, `\bfoo\b' matches any occurrence of `foo' as a
  445.      separate word.  `\bballs?\b' matches `ball' or `balls' as a
  446.      separate word.
  447.      matches the empty string, provided it is not at the beginning or
  448.      end of a word.
  449.      matches the empty string, provided it is at the beginning of a
  450.      word.
  451.      matches the empty string, provided it is at the end of a word.
  452.      matches any word-constituent character.  The editor syntax table
  453.      determines which characters these are.
  454.      matches any character that is not a word-constituent.
  455. `\sCODE'
  456.      matches any character whose syntax is CODE.  CODE is a character
  457.      which represents a syntax code: thus, `w' for word constituent,
  458.      `-' for whitespace, `(' for open-parenthesis, etc.  *Note
  459.      Syntax::.
  460. `\SCODE'
  461.      matches any character whose syntax is not CODE.
  462.    Here is a complicated regexp, used by Emacs to recognize the end of
  463. a sentence together with any whitespace that follows.  It is given in
  464. Lisp syntax to enable you to distinguish the spaces from the tab
  465. characters.  In Lisp syntax, the string constant begins and ends with
  466. a double-quote.  `\"' stands for a double-quote as part of the regexp,
  467. `\\' for a backslash as part of the regexp, `\t' for a tab and `\n'
  468. for a newline.
  469.      "[.?!][]\"')]*\\($\\|\t\\|  \\)[ \t\n]*"
  470. This contains four parts in succession: a character set matching
  471. period, `?' or `!'; a character set matching close-brackets, quotes or
  472. parentheses, repeated any number of times; an alternative in
  473. backslash-parentheses that matches end-of-line, a tab or two spaces;
  474. and a character set matching whitespace characters, repeated any
  475. number of times.
  476. File: emacs,  Node: Search Case,  Next: Replace,  Prev: Regexps,  Up: Search
  477. Searching and Case
  478. ==================
  479.    All sorts of searches in Emacs normally ignore the case of the text
  480. they are searching through; if you specify searching for `FOO', then
  481. `Foo' and `foo' are also considered a match.  Regexps, and in
  482. particular character sets, are included: `[aB]' would match `a' or `A'
  483. or `b' or `B'.
  484.    If you do not want this feature, set the variable `case-fold-search'
  485. to `nil'.  Then all letters must match exactly, including case.  This
  486. is a per-buffer variable; altering the variable affects only the
  487. current buffer, but there is a default value which you can change as
  488. well.  *Note Locals::.
  489. File: emacs,  Node: Replace,  Next: Other Repeating Search,  Prev: Search Case,  Up: Search
  490. Replacement Commands
  491. ====================
  492.    Global search-and-replace operations are not needed as often in
  493. Emacs as they are in other editors, but they are available.  In
  494. addition to the simple `replace-string' command which is like that
  495. found in most editors, there is a `query-replace' command which asks
  496. you, for each occurrence of the pattern, whether to replace it.
  497.    The replace commands all replace one string (or regexp) with one
  498. replacement string.  It is possible to perform several replacements in
  499. parallel using the command `expand-region-abbrevs'.  *Note Expanding
  500. Abbrevs::.
  501. * Menu:
  502. * Unconditional Replace::  Replacing all matches for a string.
  503. * Regexp Replace::         Replacing all matches for a regexp.
  504. * Replacement and Case::   How replacements preserve case of letters.
  505. * Query Replace::          How to use querying.
  506. File: emacs,  Node: Unconditional Replace,  Next: Regexp Replace,  Prev: Replace,  Up: Replace
  507. Unconditional Replacement
  508. -------------------------
  509. `M-x replace-string RET STRING RET NEWSTRING RET'
  510.      Replace every occurrence of STRING with NEWSTRING.
  511. `M-x replace-regexp RET REGEXP RET NEWSTRING RET'
  512.      Replace every match for REGEXP with NEWSTRING.
  513.    To replace every instance of `foo' after point with `bar', use the
  514. command `M-x replace-string' with the two arguments `foo' and `bar'. 
  515. Replacement occurs only after point, so if you want to cover the whole
  516. buffer you must go to the beginning first.  All occurrences up to the
  517. end of the buffer are replaced; to limit replacement to part of the
  518. buffer, narrow to that part of the buffer before doing the replacement
  519. (*note Narrowing::.).
  520.    When `replace-string' exits, point is left at the last occurrence
  521. replaced.  The value of point when the `replace-string' command was
  522. issued is remembered on the mark ring; `C-u C-SPC' moves back there.
  523.    A numeric argument restricts replacement to matches that are
  524. surrounded by word boundaries.
  525. File: emacs,  Node: Regexp Replace,  Next: Replacement and Case,  Prev: Unconditional Replace,  Up: Replace
  526. Regexp Replacement
  527. ------------------
  528.    `replace-string' replaces exact matches for a single string.  The
  529. similar command `replace-regexp' replaces any match for a specified
  530. pattern.
  531.    In `replace-regexp', the NEWSTRING need not be constant.  It can
  532. refer to all or part of what is matched by the REGEXP.  `\&' in
  533. NEWSTRING stands for the entire text being replaced.  `\D' in
  534. NEWSTRING, where D is a digit, stands for whatever matched the D'th
  535. parenthesized grouping in REGEXP.  For example,
  536.      M-x replace-regexp RET c[ad]+r RET \&-safe RET
  537. would replace (for example) `cadr' with `cadr-safe' and `cddr' with
  538. `cddr-safe'.
  539.      M-x replace-regexp RET \(c[ad]+r\)-safe RET \1 RET
  540. would perform exactly the opposite replacements.  To include a `\' in
  541. the text to replace with, you must give `\\'.
  542. File: emacs,  Node: Replacement and Case,  Next: Query Replace,  Prev: Regexp Replace,  Up: Replace
  543. Replace Commands and Case
  544. -------------------------
  545.    If the arguments to a replace command are in lower case, it
  546. preserves case when it makes a replacement.  Thus, the command
  547.      M-x replace-string RET foo RET bar RET
  548. replaces a lower case `foo' with a lower case `bar', `FOO' with `BAR',
  549. and `Foo' with `Bar'.  If upper case letters are used in the second
  550. argument, they remain upper case every time that argument is inserted.
  551.  If upper case letters are used in the first argument, the second
  552. argument is always substituted exactly as given, with no case
  553. conversion.  Likewise, if the variable `case-replace' is set to `nil',
  554. replacement is done without case conversion.  If `case-fold-search' is
  555. set to `nil', case is significant in matching occurrences of `foo' to
  556. replace; also, case conversion of the replacement string is not done.
  557. File: emacs,  Node: Query Replace,  Prev: Replacement and Case,  Up: Replace
  558. Query Replace
  559. -------------
  560. `M-% STRING RET NEWSTRING RET'
  561. `M-x query-replace RET STRING RET NEWSTRING RET'
  562.      Replace some occurrences of STRING with NEWSTRING.
  563. `M-x query-replace-regexp RET REGEXP RET NEWSTRING RET'
  564.      Replace some matches for REGEXP with NEWSTRING.
  565.    If you want to change only some of the occurrences of `foo' to
  566. `bar', not all of them, then you cannot use an ordinary
  567. `replace-string'.  Instead, use `M-%' (`query-replace').  This command
  568. finds occurrences of `foo' one by one, displays each occurrence and
  569. asks you whether to replace it.  A numeric argument to `query-replace'
  570. tells it to consider only occurrences that are bounded by
  571. word-delimiter characters.
  572.    Aside from querying, `query-replace' works just like
  573. `replace-string', and `query-replace-regexp' works just like
  574. `replace-regexp'.
  575.    The things you can type when you are shown an occurrence of STRING
  576. or a match for REGEXP are:
  577. `SPC'
  578.      to replace the occurrence with NEWSTRING.  This preserves case,
  579.      just like `replace-string', provided `case-replace' is non-`nil',
  580.      as it normally is.
  581. `DEL'
  582.      to skip to the next occurrence without replacing this one.
  583. `, (Comma)'
  584.      to replace this occurrence and display the result.  You are then
  585.      asked for another input character, except that since the
  586.      replacement has already been made, DEL and SPC are equivalent. 
  587.      You could type `C-r' at this point (see below) to alter the
  588.      replaced text.  You could also type `C-x u' to undo the
  589.      replacement; this exits the `query-replace', so if you want to do
  590.      further replacement you must use `C-x ESC' to restart (*note
  591.      Repetition::.).
  592. `ESC'
  593.      to exit without doing any more replacements.
  594. `. (Period)'
  595.      to replace this occurrence and then exit.
  596.      to replace all remaining occurrences without asking again.
  597.      to go back to the location of the previous occurrence (or what
  598.      used to be an occurrence), in case you changed it by mistake. 
  599.      This works by popping the mark ring.  Only one `^' in a row is
  600.      allowed, because only one previous replacement location is kept
  601.      during `query-replace'.
  602. `C-r'
  603.      to enter a recursive editing level, in case the occurrence needs
  604.      to be edited rather than just replaced with NEWSTRING.  When you
  605.      are done, exit the recursive editing level with `C-M-c' and the
  606.      next occurrence will be displayed.  *Note Recursive Edit::.
  607. `C-w'
  608.      to delete the occurrence, and then enter a recursive editing
  609.      level as in `C-r'.  Use the recursive edit to insert text to
  610.      replace the deleted occurrence of STRING.  When done, exit the
  611.      recursive editing level with `C-M-c' and the next occurrence will
  612.      be displayed.
  613. `C-l'
  614.      to redisplay the screen and then give another answer.
  615. `C-h'
  616.      to display a message summarizing these options, then give another
  617.      answer.
  618.    If you type any other character, the `query-replace' is exited, and
  619. the character executed as a command.  To restart the `query-replace',
  620. use `C-x ESC', which repeats the `query-replace' because it used the
  621. minibuffer to read its arguments.  *Note C-x ESC: Repetition.
  622. File: emacs,  Node: Other Repeating Search,  Prev: Replace,  Up: Search
  623. Other Search-and-Loop Commands
  624. ==============================
  625.    Here are some other commands that find matches for a regular
  626. expression.  They all operate from point to the end of the buffer.
  627. `M-x occur'
  628.      Print each line that follows point and contains a match for the
  629.      specified regexp.  A numeric argument specifies the number of
  630.      context lines to print before and after each matching line; the
  631.      default is none.
  632.      The buffer `*Occur*' containing the output serves as a menu for
  633.      finding the occurrences in their original context.  Find an
  634.      occurrence as listed in `*Occur*', position point there and type
  635.      `C-c C-c'; this switches to the buffer that was searched and
  636.      moves point to the original of the same occurrence.
  637. `M-x list-matching-lines'
  638.      Synonym for `M-x occur'.
  639. `M-x count-matches'
  640.      Print the number of matches following point for the specified
  641.      regexp.
  642. `M-x delete-non-matching-lines'
  643.      Delete each line that follows point and does not contain a match
  644.      for the specified regexp.
  645. `M-x delete-matching-lines'
  646.      Delete each line that follows point and contains a match for the
  647.      specified regexp.
  648. File: emacs,  Node: Fixit,  Next: Files,  Prev: Search,  Up: Top
  649. Commands for Fixing Typos
  650. *************************
  651.    In this chapter we describe the commands that are especially useful
  652. for the times when you catch a mistake in your text just after you
  653. have made it, or change your mind while composing text on line.
  654. * Menu:
  655. * Kill Errors:: Commands to kill a batch of recently entered text.
  656. * Transpose::   Exchanging two characters, words, lines, lists...
  657. * Fixing Case:: Correcting case of last word entered.
  658. * Spelling::    Apply spelling checker to a word, or a whole file.
  659. File: emacs,  Node: Kill Errors,  Next: Transpose,  Prev: Fixit,  Up: Fixit
  660. Killing Your Mistakes
  661. =====================
  662. `DEL'
  663.      Delete last character (`delete-backward-char').
  664. `M-DEL'
  665.      Kill last word (`backward-kill-word').
  666. `C-x DEL'
  667.      Kill to beginning of sentence (`backward-kill-sentence').
  668.    The DEL character (`delete-backward-char') is the most important
  669. correction command.  When used among graphic (self-inserting)
  670. characters, it can be thought of as canceling the last character typed.
  671.    When your mistake is longer than a couple of characters, it might
  672. be more convenient to use `M-DEL' or `C-x DEL'.  `M-DEL' kills back to
  673. the start of the last word, and `C-x DEL' kills back to the start of
  674. the last sentence.  `C-x DEL' is particularly useful when you are
  675. thinking of what to write as you type it, in case you change your mind
  676. about phrasing.  `M-DEL' and `C-x DEL' save the killed text for `C-y'
  677. and `M-y' to retrieve.  *Note Yanking::.
  678.    `M-DEL' is often useful even when you have typed only a few
  679. characters wrong, if you know you are confused in your typing and
  680. aren't sure exactly what you typed.  At such a time, you cannot
  681. correct with DEL except by looking at the screen to see what you did. 
  682. It requires less thought to kill the whole word and start over again.
  683. File: emacs,  Node: Transpose,  Next: Fixing Case,  Prev: Kill Errors,  Up: Fixit
  684. Transposing Text
  685. ================
  686. `C-t'
  687.      Transpose two characters (`transpose-chars').
  688. `M-t'
  689.      Transpose two words (`transpose-words').
  690. `C-M-t'
  691.      Transpose two balanced expressions (`transpose-sexps').
  692. `C-x C-t'
  693.      Transpose two lines (`transpose-lines').
  694.    The common error of transposing two characters can be fixed, when
  695. they are adjacent, with the `C-t' command (`transpose-chars'). 
  696. Normally, `C-t' transposes the two characters on either side of point.
  697.  When given at the end of a line, rather than transposing the last
  698. character of the line with the newline, which would be useless, `C-t'
  699. transposes the last two characters on the line.  So, if you catch your
  700. transposition error right away, you can fix it with just a `C-t'.  If
  701. you don't catch it so fast, you must move the cursor back to between
  702. the two transposed characters.  If you transposed a space with the
  703. last character of the word before it, the word motion commands are a
  704. good way of getting there.  Otherwise, a reverse search (`C-r') is
  705. often the best way.  *Note Search::.
  706.    `Meta-t' (`transpose-words') transposes the word before point with
  707. the word after point.  It moves point forward over a word, dragging
  708. the word preceding or containing point forward as well.  The
  709. punctuation characters between the words do not move.  For example,
  710. `FOO, BAR' transposes into `BAR, FOO' rather than `BAR FOO,'.
  711.    `C-M-t' (`transpose-sexps') is a similar command for transposing
  712. two expressions (*note Lists::.), and `C-x C-t' (`transpose-lines')
  713. exchanges lines.  They work like `M-t' except in determining the
  714. division of the text into syntactic units.
  715.    A numeric argument to a transpose command serves as a repeat count:
  716. it tells the transpose command to move the character (word, sexp,
  717. line) before or containing point across several other characters
  718. (words, sexps, lines).  For example, `C-u 3 C-t' moves the character
  719. before point forward across three other characters.  This is
  720. equivalent to repeating `C-t' three times.  `C-u - 4 M-t' moves the
  721. word before point backward across four words.  `C-u - C-M-t' would
  722. cancel the effect of plain `C-M-t'.
  723.    A numeric argument of zero is assigned a special meaning (because
  724. otherwise a command with a repeat count of zero would do nothing): to
  725. transpose the character (word, sexp, line) ending after point with the
  726. one ending after the mark.
  727. File: emacs,  Node: Fixing Case,  Next: Spelling,  Prev: Transpose,  Up: Fixit
  728. Case Conversion
  729. ===============
  730. `M-- M-l'
  731.      Convert last word to lower case.  Note `Meta--' is Meta-minus.
  732. `M-- M-u'
  733.      Convert last word to all upper case.
  734. `M-- M-c'
  735.      Convert last word to lower case with capital initial.
  736.    A very common error is to type words in the wrong case.  Because of
  737. this, the word case-conversion commands `M-l', `M-u' and `M-c' have a
  738. special feature when used with a negative argument: they do not move
  739. the cursor.  As soon as you see you have mistyped the last word, you
  740. can simply case-convert it and go on typing.  *Note Case::.
  741. File: emacs,  Node: Spelling,  Prev: Fixing Case,  Up: Fixit
  742. Checking and Correcting Spelling
  743. ================================
  744. `M-$'
  745.      Check and correct spelling of word (`spell-word').
  746. `M-x spell-buffer'
  747.      Check and correct spelling of each word in the buffer.
  748. `M-x spell-region'
  749.      Check and correct spelling of each word in the region.
  750. `M-x spell-string'
  751.      Check spelling of specified word.
  752.    To check the spelling of the word before point, and optionally
  753. correct it as well, use the command `M-$' (`spell-word').  This
  754. command runs an inferior process containing the `spell' program to see
  755. whether the word is correct English.  If it is not, it asks you to
  756. edit the word (in the minibuffer) into a corrected spelling, and then
  757. does a `query-replace' to substitute the corrected spelling for the
  758. old one throughout the buffer.
  759.    If you exit the minibuffer without altering the original spelling,
  760. it means you do not want to do anything to that word.  Then the
  761. `query-replace' is not done.
  762.    `M-x spell-buffer' checks each word in the buffer the same way that
  763. `spell-word' does, doing a `query-replace' if appropriate for every
  764. incorrect word.
  765.    `M-x spell-region' is similar but operates only on the region, not
  766. the entire buffer.
  767.    `M-x spell-string' reads a string as an argument and checks whether
  768. that is a correctly spelled English word.  It prints in the echo area a
  769. message giving the answer.
  770. File: emacs,  Node: Files,  Next: Buffers,  Prev: Fixit,  Up: Top
  771. File Handling
  772. *************
  773.    The basic unit of stored data in Unix is the "file".  To edit a
  774. file, you must tell Emacs to examine the file and prepare a buffer
  775. containing a copy of the file's text.  This is called "visiting" the
  776. file.  Editing commands apply directly to text in the buffer; that is,
  777. to the copy inside Emacs.  Your changes appear in the file itself only
  778. when you "save" the buffer back into the file.
  779.    In addition to visiting and saving files, Emacs can delete, copy,
  780. rename, and append to files, and operate on file directories.
  781. * Menu:
  782. * File Names::   How to type and edit file name arguments.
  783. * Visiting::     Visiting a file prepares Emacs to edit the file.
  784. * Saving::       Saving makes your changes permanent.
  785. * Reverting::    Reverting cancels all the changes not saved.
  786. * Auto Save::    Auto Save periodically protects against loss of data.
  787. * ListDir::      Listing the contents of a file directory.
  788. * Dired::        "Editing" a directory to delete, rename, etc.
  789.                   the files in it.
  790. * Misc File Ops:: Other things you can do on files.
  791. File: emacs,  Node: File Names,  Next: Visiting,  Prev: Files,  Up: Files
  792. File Names
  793. ==========
  794.    Most Emacs commands that operate on a file require you to specify
  795. the file name.  (Saving and reverting are exceptions; the buffer knows
  796. which file name to use for them.)  File names are specified using the
  797. minibuffer (*note Minibuffer::.).  "Completion" is available, to make
  798. it easier to specify long file names.  *Note Completion::.
  799.    There is always a "default file name" which will be used if you type
  800. just RET, entering an empty argument.  Normally the default file name
  801. is the name of the file visited in the current buffer; this makes it
  802. easy to operate on that file with any of the Emacs file commands.
  803.    Each buffer has a default directory, normally the same as the
  804. directory of the file visited in that buffer.  When Emacs reads a file
  805. name, if you do not specify a directory, the default directory is
  806. used.  If you specify a directory in a relative fashion, with a name
  807. that does not start with a slash, it is interpreted with respect to
  808. the default directory.  The default directory is kept in the variable
  809. `default-directory', which has a separate value in every buffer.
  810.    For example, if the default file name is `/u/rms/gnu/gnu.tasks' then
  811. the default directory is `/u/rms/gnu/'.  If you type just `foo', which
  812. does not specify a directory, it is short for `/u/rms/gnu/foo'. 
  813. `../.login' would stand for `/u/rms/.login'.  `new/foo' would stand
  814. for the filename `/u/rms/gnu/new/foo'.
  815.    The command `M-x pwd' prints the current buffer's default directory,
  816. and the command `M-x cd' sets it (to a value read using the
  817. minibuffer).  A buffer's default directory changes only when the `cd'
  818. command is used.  A file-visiting buffer's default directory is
  819. initialized to the directory of the file that is visited there.  If a
  820. buffer is made randomly with `C-x b', its default directory is copied
  821. from that of the buffer that was current at the time.
  822.    The default directory actually appears in the minibuffer when the
  823. minibuffer becomes active to read a file name.  This serves two
  824. purposes: it shows you what the default is, so that you can type a
  825. relative file name and know with certainty what it will mean, and it
  826. allows you to edit the default to specify a different directory.  This
  827. insertion of the default directory is inhibited if the variable
  828. `insert-default-directory' is set to `nil'.
  829.    Note that it is legitimate to type an absolute file name after you
  830. enter the minibuffer, ignoring the presence of the default directory
  831. name as part of the text.  The final minibuffer contents may look
  832. invalid, but that is not so.  *Note Minibuffer File::.
  833.    `$' in a file name is used to substitute environment variables.  For
  834. example, if you have used the shell command `setenv FOO rms/hacks' to
  835. set up an environment variable named `FOO', then you can use
  836. `/u/$FOO/test.c' or `/u/${FOO}/test.c' as an abbreviation for
  837. `/u/rms/hacks/test.c'.  The environment variable name consists of all
  838. the alphanumeric characters after the `$'; alternatively, it may be
  839. enclosed in braces after the `$'.  Note that the `setenv' command
  840. affects Emacs only if done before Emacs is started.
  841.    To access a file with `$' in its name, type `$$'.  This pair is
  842. converted to a single `$' at the same time as variable substitution is
  843. performed for single `$'.  The Lisp function that performs the
  844. substitution is called `substitute-in-file-name'.  The substitution is
  845. performed only on filenames read as such using the minibuffer.
  846.